<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Request</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Request</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Request class</p>
<p class="description"><p>Wrapper around a <div class="src-code"><ol><li><div class="src-line"><span class="src-var">$_POST</span><span class="src-sym">,&nbsp;</span><span class="src-var">$_GET&nbsp;</span><span class="src-key">and&nbsp;</span><span class="src-var">$_FILES</span></div></li>
</ol></div></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_http---Request.php.html">/http/Request.php</a> (line <span class="field">41</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#SCHEME_HTTP" title="details" class="const-name">SCHEME_HTTP</a> = 					<span class="var-type"> &quot;http&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#SCHEME_HTTPS" title="details" class="const-name">SCHEME_HTTPS</a> = 					<span class="var-type"> &quot;https&quot;</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																																																																																																																																																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$attributes" title="details" class="var-name">$attributes</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$contentLength" title="details" class="var-name">$contentLength</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$contentType" title="details" class="var-name">$contentType</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../http/Context.html">Context</a></span>
					<a href="#$context" title="details" class="var-name">$context</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$contextPath" title="details" class="var-name">$contextPath</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../http/Locale.html">Locale</a></span>
					<a href="#$defaultLocale" title="details" class="var-name">$defaultLocale</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$locales" title="details" class="var-name">$locales</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$localesParsed" title="details" class="var-name">$localesParsed</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$method" title="details" class="var-name">$method</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$parameters" title="details" class="var-name">$parameters</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$parsed" title="details" class="var-name">$parsed</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$pathInfo" title="details" class="var-name">$pathInfo</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$protocol" title="details" class="var-name">$protocol</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$queryString" title="details" class="var-name">$queryString</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$requestedSessionCookie" title="details" class="var-name">$requestedSessionCookie</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$requestedSessionId" title="details" class="var-name">$requestedSessionId</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$requestedSessionURL" title="details" class="var-name">$requestedSessionURL</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$requestURI" title="details" class="var-name">$requestURI</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$scheme" title="details" class="var-name">$scheme</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$secure" title="details" class="var-name">$secure</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$serverName" title="details" class="var-name">$serverName</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$serverPort" title="details" class="var-name">$serverPort</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../http/Session.html">Session</a></span>
					<a href="#$session" title="details" class="var-name">$session</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../aas/GenericPrincipal.html">GenericPrincipal</a></span>
					<a href="#$userPrincipal" title="details" class="var-name">$userPrincipal</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																																																																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addLocale" title="details" class="method-name">addLocale</a>
											(<span class="var-type"><a href="../http/Locale.html">Locale</a></span>&nbsp;<span class="var-name">$locale</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addParameter" title="details" class="method-name">addParameter</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">values</span>&nbsp;<span class="var-name">$values</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#getAttribute" title="details" class="method-name">getAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getAttributeNames" title="details" class="method-name">getAttributeNames</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getAuthType" title="details" class="method-name">getAuthType</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getContentLength" title="details" class="method-name">getContentLength</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getContentType" title="details" class="method-name">getContentType</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getContext" title="details" class="method-name">getContext</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getContextPath" title="details" class="method-name">getContextPath</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getLocale" title="details" class="method-name">getLocale</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getLocales" title="details" class="method-name">getLocales</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getMethod" title="details" class="method-name">getMethod</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#getParameter" title="details" class="method-name">getParameter</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getParameterMap" title="details" class="method-name">getParameterMap</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getParameterNames" title="details" class="method-name">getParameterNames</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getParameterValues" title="details" class="method-name">getParameterValues</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getPathInfo" title="details" class="method-name">getPathInfo</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getProtocol" title="details" class="method-name">getProtocol</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getQueryString" title="details" class="method-name">getQueryString</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getRequestURI" title="details" class="method-name">getRequestURI</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getScheme" title="details" class="method-name">getScheme</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">a</span>
										<a href="#getServerName" title="details" class="method-name">getServerName</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">an</span>
										<a href="#getServerPort" title="details" class="method-name">getServerPort</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../http/Session.html">Session</a></span>
										<a href="#getSession" title="details" class="method-name">getSession</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">UserPrincipal</span>
										<a href="#getUserPrincipal" title="details" class="method-name">getUserPrincipal</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#isRequestedSessionIdFromCookie" title="details" class="method-name">isRequestedSessionIdFromCookie</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#isRequestedSessionIdFromURL" title="details" class="method-name">isRequestedSessionIdFromURL</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#isSecure" title="details" class="method-name">isSecure</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#isUserInRole" title="details" class="method-name">isUserInRole</a>
											(<span class="var-type">role</span>&nbsp;<span class="var-name">$role</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#parseLocales" title="details" class="method-name">parseLocales</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#parseLocalesHeader" title="details" class="method-name">parseLocalesHeader</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeAttribute" title="details" class="method-name">removeAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$key</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAttribute" title="details" class="method-name">setAttribute</a>
											(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setAuthType" title="details" class="method-name">setAuthType</a>
											(<span class="var-type">authType</span>&nbsp;<span class="var-name">$authType</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setContext" title="details" class="method-name">setContext</a>
											(<span class="var-type">context</span>&nbsp;<span class="var-name">$context</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setQueryString" title="details" class="method-name">setQueryString</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$queryString</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRequestedSessionCookie" title="details" class="method-name">setRequestedSessionCookie</a>
											(<span class="var-type">flag</span>&nbsp;<span class="var-name">$flag</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRequestedSessionId" title="details" class="method-name">setRequestedSessionId</a>
											(<span class="var-type">id</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRequestedSessionURL" title="details" class="method-name">setRequestedSessionURL</a>
											(<span class="var-type">flag</span>&nbsp;<span class="var-name">$flag</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRequestURI" title="details" class="method-name">setRequestURI</a>
											(<span class="var-type">uri</span>&nbsp;<span class="var-name">$requestURI</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setUserPrincipal" title="details" class="method-name">setUserPrincipal</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#__toString" title="details" class="method-name">__toString</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$attributes" id="$attributes"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$attributes</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">62</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The attributes associated with this Request, keyed by attribute name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$contentLength" id="$contentLength"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$contentLength</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">68</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The content length associated with this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$contentType" id="$contentType"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$contentType</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">74</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The content type associated with this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$context" id="$context"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../http/Context.html">Context</a></span>
			<span class="var-name">$context</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">82</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Context within which this Request is being processed.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$contextPath" id="$contextPath"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$contextPath</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">88</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The context path for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$defaultLocale" id="$defaultLocale"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../http/Locale.html">Locale</a></span>
			<span class="var-name">$defaultLocale</span>
						(line <span class="line-number">96</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The default Locale if none are specified.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$locales" id="$locales"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$locales</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">102</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The preferred Locales assocaited with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$localesParsed" id="$localesParsed"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$localesParsed</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">108</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse locales.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$method" id="$method"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$method</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">114</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The request method associated with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$parameters" id="$parameters"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$parameters</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">129</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The parsed parameters for this request.  This is populated only if</p>
<p class="description"><p>parameter information is requested via one of the  <div class="src-code"><ol><li><div class="src-line"><a href="../http/Request.html#methodgetParameter">getParameter</a><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> family of method calls.  The key is the  parameter name, while the value is a String array of values for this  parameter.  &lt;p&gt;
 &lt;strong&gt;IMPLEMENTATION NOTE&lt;/strong&gt; - Once the parameters for a  particular request are parsed and stored here, they are not modified.  Therefore, application level access to the parameters need not be  synchronized.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$parsed" id="$parsed"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$parsed</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">135</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Have the parameters for this request been parsed yet?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$pathInfo" id="$pathInfo"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$pathInfo</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">141</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The path information for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$protocol" id="$protocol"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$protocol</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">147</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The protocol name and version associated with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$queryString" id="$queryString"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$queryString</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">153</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The query string for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$requestedSessionCookie" id="$requestedSessionCookie"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$requestedSessionCookie</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">159</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was the requested session ID received in a cookie?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$requestedSessionId" id="$requestedSessionId"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$requestedSessionId</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">165</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The requested session ID (if any) for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$requestedSessionURL" id="$requestedSessionURL"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$requestedSessionURL</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">171</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was the requested session ID received in a URL?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$requestURI" id="$requestURI"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$requestURI</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">177</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The request URI associated with this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$scheme" id="$scheme"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$scheme</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">183</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The scheme associated with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$secure" id="$secure"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$secure</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">189</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was this request received on a secure channel?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$serverName" id="$serverName"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$serverName</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">195</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The server name associated with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$serverPort" id="$serverPort"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$serverPort</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">201</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The server port associated with this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$session" id="$session"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../http/Session.html">Session</a></span>
			<span class="var-name">$session</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">209</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The currently active session for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$userPrincipal" id="$userPrincipal"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../aas/GenericPrincipal.html">GenericPrincipal</a></span>
			<span class="var-name">$userPrincipal</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">217</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Principal who has been authenticated for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">231</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct a new Request using a request uri</p>
<p class="description"><p>Sets the uri instance variable</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$uri</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddLocale" id="addLocale"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addLocale</span> (line <span class="line-number">866</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a Locale to the set of preferred Locales for this Request.  The  first added Locale will be the first one returned by getLocales().</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addLocale
		</span>
					(<span class="var-type"><a href="../http/Locale.html">Locale</a></span>&nbsp;<span class="var-name">$locale</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">locale</span>
				<span class="var-name">$locale</span><span class="var-description">: The new preferred Locale</span>			</li>
				</ul>
		
			
	</div>
<a name="methodaddParameter" id="addParameter"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addParameter</span> (line <span class="line-number">451</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a parameter name and corresponding set of values to this Request.</p>
<p class="description"><p>(This is used when restoring the original request on a form based  login).</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			addParameter
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">values</span>&nbsp;<span class="var-name">$values</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of this request parameter</span>			</li>
					<li>
				<span class="var-type">values</span>
				<span class="var-name">$values</span><span class="var-description">: Corresponding values for this request parameter</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetAttribute" id="getAttribute"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAttribute</span> (line <span class="line-number">275</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the value of the specified request attribute, if any; otherwise,  return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.  If there is more than one value defined,  return only the first one.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			getAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the desired request attribute</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetAttributeNames" id="getAttributeNames"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getAttributeNames</span> (line <span class="line-number">286</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the names of all defined request attributes for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getAttributeNames
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetAuthType" id="getAuthType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getAuthType</span> (line <span class="line-number">332</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the authentication type used for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getAuthType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetContentLength" id="getContentLength"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getContentLength</span> (line <span class="line-number">352</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the content length for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getContentLength
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetContentType" id="getContentType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getContentType</span> (line <span class="line-number">363</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the content type for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getContentType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetContext" id="getContext"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getContext</span> (line <span class="line-number">386</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the Context within which this Request is being processed.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getContext
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetContextPath" id="getContextPath"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getContextPath</span> (line <span class="line-number">419</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the portion of the request URI that indicates the context</p>
<p class="description"><p>of the request.  The context path always comes first in a request  URI.  The path starts with a &quot;/&quot; character but does not end with a &quot;/&quot;  character.  For servlets in the default (root) context, this method  returns &quot;&quot;. The container does not decode this string.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> specifying the               portion of the request URI that indicates the context               of the request</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getContextPath
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLocale" id="getLocale"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getLocale</span> (line <span class="line-number">826</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the preferred Locale that the client will accept content in,  based on the value for the first <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Accept</span>-<span class="src-id">Language</span></div></li>
</ol></div> header  that was encountered.  If the request did not specify a preferred  language, $the server's default Locale is returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getLocale
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLocales" id="getLocales"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLocales</span> (line <span class="line-number">846</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the set of preferred Locales that the client will accept  content in, $based on the values for any <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Accept</span>-<span class="src-id">Language</span></div></li>
</ol></div>  headers that were encountered.  If the request did not specify a  preferred language, $the server's default Locale is returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getLocales
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMethod" id="getMethod"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getMethod</span> (line <span class="line-number">435</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of the HTTP method with which this  request was made, for example, GET, POST, or PUT.</p>
<p class="description"><p>Same as the value of the CGI variable REQUEST_METHOD.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div>          specifying the name          of the method with which          this request was made</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getMethod
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetParameter" id="getParameter"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getParameter</span> (line <span class="line-number">464</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the value of the specified request parameter, if any; otherwise,  return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.  If there is more than one value defined,  return only the first one.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			getParameter
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the desired request parameter</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetParameterMap" id="getParameterMap"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getParameterMap</span> (line <span class="line-number">488</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Map</span></div></li>
</ol></div> of the parameters of this request.</p>
<p class="description"><p>Request parameters are extra information sent with the request.  For HTTP servlets, parameters are contained in the query string  or posted form data.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> A <div class="src-code"><ol><li><div class="src-line"><span class="src-id">Map</span></div></li>
</ol></div> containing parameter names as keys   and parameter values as map values.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getParameterMap
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetParameterNames" id="getParameterNames"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getParameterNames</span> (line <span class="line-number">499</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the names of all defined request parameters for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getParameterNames
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetParameterValues" id="getParameterValues"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getParameterValues</span> (line <span class="line-number">513</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the defined values for the specified request parameter, if any;  otherwise, return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getParameterValues
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the desired request parameter</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetPathInfo" id="getPathInfo"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getPathInfo</span> (line <span class="line-number">549</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns any extra path information associated with  the URL the client sent when it made this request.</p>
<p class="description"><p>The extra path information follows the servlet path  but precedes the query string.  This method returns <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if there  was no extra path information.</p><p>&lt;p&gt;Same as the value of the CGI variable PATH_INFO.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div>, decoded by the           web container, specifying           extra path information that comes           after the servlet path but before           the query string in the request URL;           or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if the URL does not have           any extra path information</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getPathInfo
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetProtocol" id="getProtocol"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getProtocol</span> (line <span class="line-number">567</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name and version of the protocol the request uses</p>
<p class="description"><p>in the form <em>protocol/majorVersion.minorVersion</em>, for  example, HTTP/1.1. For HTTP servlets, the value  returned is the same as the value of the CGI variable  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">SERVER_PROTOCOL</span></div></li>
</ol></div>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> containing the protocol           name and version number</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getProtocol
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetQueryString" id="getQueryString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getQueryString</span> (line <span class="line-number">577</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the query string associated with this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getQueryString
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetRequestURI" id="getRequestURI"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getRequestURI</span> (line <span class="line-number">597</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the request URI for this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getRequestURI
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetScheme" id="getScheme"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getScheme</span> (line <span class="line-number">687</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the name of the scheme used to make this request,  for example,  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">http</span></div></li>
</ol></div>, <div class="src-code"><ol><li><div class="src-line"><span class="src-id">https</span></div></li>
</ol></div>, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">ftp</span></div></li>
</ol></div>.</p>
<p class="description"><p>Different schemes have different rules for constructing URLs,  as noted in RFC 1738.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> containing the name           of the scheme used to make this request</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getScheme
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetServerName" id="getServerName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getServerName</span> (line <span class="line-number">727</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the host name of the server that received the request.</p>
<p class="description"><p>For HTTP servlets, same as the value of the CGI variable  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">SERVER_NAME</span></div></li>
</ol></div>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> <div class="src-code"><ol><li><div class="src-line"><span class="src-id">String</span></div></li>
</ol></div> containing the name           of the server to which the request was sent</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">a</span>
		<span class="method-name">
			getServerName
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetServerPort" id="getServerPort"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getServerPort</span> (line <span class="line-number">743</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the port number on which this request was received.</p>
<p class="description"><p>For HTTP servlets, same as the value of the CGI variable  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">SERVER_PORT</span></div></li>
</ol></div>.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> integer specifying the port number</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">an</span>
		<span class="method-name">
			getServerPort
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetSession" id="getSession"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getSession</span> (line <span class="line-number">756</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the object bound with the specified name to the internal notes  for this request, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if no such binding exists.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../http/Session.html">Session</a></span>
		<span class="method-name">
			getSession
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetUserPrincipal" id="getUserPrincipal"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getUserPrincipal</span> (line <span class="line-number">812</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the principal that has been authenticated for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">UserPrincipal</span>
		<span class="method-name">
			getUserPrincipal
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisRequestedSessionIdFromCookie" id="isRequestedSessionIdFromCookie"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isRequestedSessionIdFromCookie</span> (line <span class="line-number">771</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the session identifier included in this  request came from a cookie.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			isRequestedSessionIdFromCookie
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisRequestedSessionIdFromURL" id="isRequestedSessionIdFromURL"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isRequestedSessionIdFromURL</span> (line <span class="line-number">785</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the session identifier included in this  request came from the request URI.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			isRequestedSessionIdFromURL
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisSecure" id="isSecure"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isSecure</span> (line <span class="line-number">712</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Was this request received on a secure connection?</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			isSecure
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisUserInRole" id="isUserInRole"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isUserInRole</span> (line <span class="line-number">656</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if the authenticated user principal  possesses the specified role name.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			isUserInRole
		</span>
					(<span class="var-type">role</span>&nbsp;<span class="var-name">$role</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">role</span>
				<span class="var-name">$role</span><span class="var-description">: Role name to be validated</span>			</li>
				</ul>
		
			
	</div>
<a name="methodparseLocales" id="parseLocales"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">parseLocales</span> (line <span class="line-number">874</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse request locales.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			parseLocales
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodparseLocalesHeader" id="parseLocalesHeader"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">parseLocalesHeader</span> (line <span class="line-number">885</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse accept-language header value.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			parseLocalesHeader
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$value</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremoveAttribute" id="removeAttribute"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeAttribute</span> (line <span class="line-number">297</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove the specified request attribute if it exists.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$key</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$key</span><span class="var-description">: Name of the request attribute to remove</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAttribute" id="setAttribute"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setAttribute</span> (line <span class="line-number">311</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the specified request attribute to the specified value.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAttribute
		</span>
					(<span class="var-type">name</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">name</span>
				<span class="var-name">$name</span><span class="var-description">: Name of the request attribute to set</span>			</li>
					<li>
				<span class="var-type">value</span>
				<span class="var-name">$value</span><span class="var-description">: The associated value  $return void</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetAuthType" id="setAuthType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setAuthType</span> (line <span class="line-number">344</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the authentication type used for this request, if any; otherwise  set the type to <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div>.  Typical values are &quot;BASIC&quot;,  &quot;DIGEST&quot;, or &quot;SSL&quot;.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setAuthType
		</span>
					(<span class="var-type">authType</span>&nbsp;<span class="var-name">$authType</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">authType</span>
				<span class="var-name">$authType</span><span class="var-description">: The authentication type used</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetContext" id="setContext"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setContext</span> (line <span class="line-number">400</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the Context within which this Request is being processed.  This  must be called as soon as the appropriate Context is identified, because  it identifies the value to be returned by <div class="src-code"><ol><li><div class="src-line"><span class="src-id">getContextPath</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div>,  and thus enables parsing of the request URI.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setContext
		</span>
					(<span class="var-type">context</span>&nbsp;<span class="var-name">$context</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">context</span>
				<span class="var-name">$context</span><span class="var-description">: The newly associated Context</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetQueryString" id="setQueryString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setQueryString</span> (line <span class="line-number">587</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the query string associated with this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setQueryString
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$queryString</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$queryString</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetRequestedSessionCookie" id="setRequestedSessionCookie"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setRequestedSessionCookie</span> (line <span class="line-number">621</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a flag indicating whether or not the requested session ID for this  request came in through a cookie.  This is normally called by the  HTTP Connector, when it parses the request headers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRequestedSessionCookie
		</span>
					(<span class="var-type">flag</span>&nbsp;<span class="var-name">$flag</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">flag</span>
				<span class="var-name">$flag</span><span class="var-description">: The new flag</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetRequestedSessionId" id="setRequestedSessionId"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setRequestedSessionId</span> (line <span class="line-number">632</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the requested session ID for this request.  This is normally called  by the HTTP Connector, when it parses the request headers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRequestedSessionId
		</span>
					(<span class="var-type">id</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">id</span>
				<span class="var-name">$id</span><span class="var-description">: The new session id</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetRequestedSessionURL" id="setRequestedSessionURL"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setRequestedSessionURL</span> (line <span class="line-number">644</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set a flag indicating whether or not the requested session ID for this  request came in through a URL.  This is normally called by the  HTTP Connector, when it parses the request headers.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRequestedSessionURL
		</span>
					(<span class="var-type">flag</span>&nbsp;<span class="var-name">$flag</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">flag</span>
				<span class="var-name">$flag</span><span class="var-description">: The new flag</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetRequestURI" id="setRequestURI"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setRequestURI</span> (line <span class="line-number">610</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the unparsed request URI for this Request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRequestURI
		</span>
					(<span class="var-type">uri</span>&nbsp;<span class="var-name">$requestURI</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">uri</span>
				<span class="var-name">$requestURI</span><span class="var-description">: The request URI</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetUserPrincipal" id="setUserPrincipal"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setUserPrincipal</span> (line <span class="line-number">803</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the Principal who has been authenticated for this Request.  This  value is also used to calculate the value to be returned by the  <div class="src-code"><ol><li><div class="src-line"><span class="src-id">getRemoteUser</span><span class="src-sym">(</span><span class="src-sym">)</span></div></li>
</ol></div> method.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setUserPrincipal
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">principal</span>
				<span class="var-name">$principal</span><span class="var-description">: The user Principal</span>			</li>
				</ul>
		
			
	</div>
<a name="method__toString" id="__toString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">__toString</span> (line <span class="line-number">1054</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">String representation of this request.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			__toString
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constSCHEME_HTTP" id="SCHEME_HTTP"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">SCHEME_HTTP</span>
			 = <span class="const-default"> &quot;http&quot;</span>
			(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">scheme constants</p>
	
	
</div>
<a name="constSCHEME_HTTPS" id="SCHEME_HTTPS"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">SCHEME_HTTPS</span>
			 = <span class="const-default"> &quot;https&quot;</span>
			(line <span class="line-number">51</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:18 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>